Azure Monitor Ingestion (stable:2023-01-01)

2025/07/09 • 1 updated methods

Upload (updated)
Description Ingestion API used to directly ingest data using Data Collection Rules.
Reference Link ¶

⚶ Changes

{
  "#id": "Upload",
  "Description": {
    "new": "Ingestion API used to directly ingest data using Data Collection Rules.",
    "old": "See error response code and error response message for more detail."
  },
  "Summary": {
    "new": "Ingestion API used to directly ingest data using Data Collection Rules.",
    "old": "Ingestion API used to directly ingest data using Data Collection Rules"
  },
  "$parameters": [
    {
      "#name": "ruleId",
      "Description": {
        "new": "The immutable ID of the Data Collection Rule resource.",
        "old": "The immutable Id of the Data Collection Rule resource."
      }
    },
    {
      "#name": "Content-Encoding",
      "Description": {
        "new": "The content encoding of the request body which is always 'gzip'.",
        "old": "gzip"
      }
    },
    {
      "#name": "x-ms-client-request-id",
      "Description": {
        "new": "An opaque, globally-unique, client-generated string identifier for the request.",
        "old": "Client request Id"
      }
    },
    {
      "#name": "body",
      "Description": {
        "new": "The array of objects matching the schema defined by the provided stream.",
        "old": "An array of objects matching the schema defined by the provided stream."
      }
    }
  ],
  "$responses": [
    {
      "#status": "default",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": {
            "new": "String error code indicating what went wrong.",
            "old": "A value that indicates the ingestion service error code."
          }
        }
      ],
      "$schema": {
        "Description": {
          "new": "A response containing error details.",
          "old": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)."
        },
        "$properties": [
          {
            "#name": "error",
            "Required": {
              "new": true,
              "old": false
            },
            "$properties": [
              {
                "#name": "code",
                "Description": {
                  "new": "One of a server-defined set of error codes.",
                  "old": "The error code."
                },
                "Required": {
                  "new": true,
                  "old": false
                }
              },
              {
                "#name": "message",
                "Description": {
                  "new": "A human-readable representation of the error.",
                  "old": "The error message."
                },
                "Required": {
                  "new": true,
                  "old": false
                }
              },
              {
                "#name": "target",
                "Description": {
                  "new": "The target of the error.",
                  "old": "The error target."
                }
              },
              {
                "#name": "details",
                "Description": {
                  "new": "An array of details about specific errors that led to this reported error.",
                  "old": "The error details."
                }
              },
              {
                "@added_0c09063f5f8442aaafd8e511397aee47": {
                  "#name": "innererror",
                  "Description": "An object containing more specific information than the current object about the error.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "One of a server-defined set of error codes.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "innererror",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "@removed_879289946deb47709d5d38a072908d1e": {
                  "#name": "additionalInfo",
                  "Description": "The error additional info.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "The resource management error additional info.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "type",
                        "Description": "The additional info type.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "info",
                        "Description": "The additional info.",
                        "Required": false,
                        "Type": "object"
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /dataCollectionRules/{ruleId}/streams/{stream}
{
api-version: string ,
ruleId: string ,
stream: string ,
Content-Encoding: string ,
x-ms-client-request-id: string ,
body: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}